Inside Macintosh: Telephony /

Chapter 2 - Telephone Terminals

Telephone Terminals Summary

C Summary

Constants

Telephone Terminal Feature Flags

enum {
   pcmAvail                      = 1L << 0,
   hasHandset                    = 1L << 1,
   hasSpeakerphone               = 1L << 2,
   canOnHookDial                 = 1L << 3,
   hasRinger                     = 1L << 4,
   canSetDisplay                 = 1L << 5,
   hasKeypad                     = 1L << 6,
   hasVideo                      = 1L << 7,
   hasOther                      = 1L << 8,
   crossDNConference             = 1L << 9,
   hasSubaddress                 = 1L << 10,
   hasUserUserInfo               = 1L << 11,
   hasHandsetSoundStreams        = 1L << 12,
   hasIndHandset                 = 1L << 13,
   hasBuiltinSpeakerphone        = 1L << 14
};

Display Modes

enum {
   telNormalDisplayMode          = 1,
   telInspectMode                = 2,
   telMiscMode                   = 3,
   telRetrieveMode               = 4,
   telDirectoryQueryMode         = 5
};

Display Items

enum {
   telEntireDisplay              = 0
};

Hookswitch Types and States

enum {
   telHandset                    = 1,
   telSpeakerphone               = 2
};
enum {
   telDeviceOffHook              = 1,
   telDeviceOnHook               = 0
};

Volume Controls

enum {
   telHandsetSpeakerVol          = 1,
   telHandsetMicVol              = 2,
   telSpeakerphoneVol            = 3,
   telSpeakerphoneMicVol         = 4,
   telRingerVol                  = 5,
   telBuiltinSPVol               = 6,
   telBuiltinSPMicVol            = 7
};
enum {
   telVolSame                    = 0,
   telVolMin                     = 1,
   telVolMax                     = 100
};
enum {
   telVolStateSame               = 0,
   telVolStateOff                = 1,
   telVolStateOn                 = 2
};

Independent Handset States

enum {
   telIndHSDisconnected          = 0,
   telIndHSConnected             = 1
};
enum {
   telIndHSOnHook                = 0,
   telIndHSOffHook               = 1
};

Alerting Patterns

enum {
   telPattern0                   = 0,
   telPattern1                   = 1,
   telPattern2                   = 2,
   telPattern3                   = 3,
   telPattern4                   = 4,
   telPattern5                   = 5,
   telPattern6                   = 6,
   telPattern7                   = 7,
   telPatternOff                 = 8,
   telPatternUndefined           = 15
};

Data Types

Telephone Terminal Record

struct TELTermRecord {
   short                         tRef;
   TELFeatureFlags               featureFlags;
   short                         handsetSpeakerVol;
   short                         handsetMicVol;
   short                         speakerphoneVol;
   short                         speakerphoneMicVol;
   short                         ringerVol;
   short                         otherVol;
   short                         ringerTypes;
   short                         hasDisplay;
   short                         displayRows;
   short                         numDNs;
   short                         maxAllocCA;
   short                         curAllocCA;
   short                         builtinSpeakerVol;
   short                         builtinSpeakerMicVol;
   long                          reserved;
};
typedef struct TELTermRecord TELTermRecord;
typedef TELTermRecord *TELTermPtr;

Telephone Terminals Functions

Opening and Closing Telephone Terminals

pascal TELErr TELOpenTerm       (TELHandle hTEL);
pascal TELErr TELCloseTerm      (TELHandle hTEL);
pascal TELErr TELResetTerm      (TELHandle hTEL);
pascal TELErr TELDispose        (TELHandle hTEL);

Getting Information About Telephone Terminals

pascal TELErr TELGetInfo        (TELHandle hTEL);

Monitoring and Controlling Telephone Terminals

pascal TELErr TELGetHooksw      (TELHandle hTEL, short hookType, Boolean *offHook);
pascal TELErr TELSetHooksw      (TELHandle hTEL, short hookType, Boolean offHook);
pascal TELErr TELGetVolume      (TELHandle hTEL, 
                                 short volType, 
                                 short *level, 
                                 short *volState);
pascal TELErr TELSetVolume      (TELHandle hTEL, 
                                 short volType, 
                                 short *level, 
                                 short volState);
pascal TELErr TELGetDisplay     (TELHandle hTEL, 
                                 short index, 
                                 short *displayMode, 
                                 StringPtr *text);
pascal TELErr TELSetDisplay     (TELHandle hTEL, 
                                 short index, 
                                 short displayMode, 
                                 ConstStr255Param text);
pascal TELErr TELAlert          (TELHandle hTEL, short *level, short alertPattern);
pascal TELErr TELHSGetDTMF      (TELHandle termHand, Boolean *dtmfOn);
pascal TELErr TELHSSetDTMF      (TELDNHandle termHand, Boolean dtmfOn);
pascal TELErr TELGetIndHSConnect(TELHandle termHand, Boolean *Connect);
pascal TELErr TELSetIndHSConnect(TELHandle termHand, Boolean Connect);

Managing Sound Input Drivers and Sound Output Components

pascal TELErr TELGetHSSoundInput(TELHandle termHand, Str255 deviceName);
pascal TELErr TELDisposeHSSoundInput(
                                 TELHandle termHand, ConstStr255Param deviceName);
pascal TELErr TELGetHSSoundOutput(
                                 TELHandle termHand, Component *SndOut);
pascal TELErr TELDisposeHSSoundOutput(
                                 TELHandle termHand, Component SndOut);

Allocating Processor Time to Telephone Tools

pascal void TELIdle             (TELHandle hTEL);

Pascal Summary

Constants

Telephone Terminal Feature Flags

CONST
   pcmAvail                      = $00000001;
   hasHandset                    = $00000002;
   hasSpeakerphone               = $00000004;
   canOnHookDial                 = $00000008;
   hasRinger                     = $00000010;
   canSetDisplay                 = $00000020;
   hasKeypad                     = $00000040;
   hasVideo                      = $00000080;
   hasOther                      = $00000100;
   crossDNConference             = $00000200;
   hasSubaddress                 = $00000400;
   hasUserUserInfo               = $00000800;
   hasHandsetSoundStreams        = $00001000;
   hasIndHandset                 = $00002000;
   hasBuiltinSpeakerphone        = $00004000;

Display Modes

CONST
   telNormalDisplayMode          = 1;
   telInspectMode                = 2;
   telMiscMode                   = 3;
   telRetrieveMode               = 4;
   telDirectoryQueryMode         = 5;

Display Items

CONST
   telEntireDisplay              = 0;

Hookswitch Types and States

CONST
   telHandset                    = 1;
   telSpeakerphone               = 2;
   telDeviceOffHook              = 1;
   telDeviceOnHook               = 0;

Volume Controls

CONST
   telHandsetSpeakerVol          = 1;
   telHandsetMicVol              = 2;
   telSpeakerphoneVol            = 3;
   telSpeakerphoneMicVol         = 4;
   telRingerVol                  = 5;
   telBuiltinSPVol               = 6;
   telBuiltinSPMicVol            = 7;
   telVolSame                    = 0;
   telVolMin                     = 1;
   telVolMax                     = 100;
   telVolStateSame               = 0;
   telVolStateOff                = 1;
   telVolStateOn                 = 2;

Independent Handset States

CONST
   telIndHSDisconnected          = 0;
   telIndHSConnected             = 1;
   telIndHSOnHook                = 0;
   telIndHSOffHook               = 1;

Alerting Patterns

CONST
   telPattern0                   = 0;
   telPattern1                   = 1;
   telPattern2                   = 2;
   telPattern3                   = 3;
   telPattern4                   = 4;
   telPattern5                   = 5;
   telPattern6                   = 6;
   telPattern7                   = 7;
   telPatternOff                 = 8;
   telPatternUndefined           = 15;

Data Types

Telephone Terminal Record

TYPE
   TELTermRecord = 
   RECORD
      tRef:                      Integer;
      featureFlags:              TELFeatureFlags;
      handsetSpeakerVol:         Integer;
      handsetMicVol:             Integer;
      speakerphoneVol:           Integer;
      speakerphoneMicVol:        Integer;
      ringerVol:                 Integer;
      otherVol:                  Integer;
      ringerTypes:               Integer;
      hasDisplay:                Integer;
      displayRows:               Integer;
      numDNs:                    Integer;
      maxAllocCA:                Integer;
      curAllocCA:                Integer;
      builtinSpeakerVol:         Integer;
      builtinSpeakerMicVol:      Integer;
      reserved:                  LongInt;
   END;
   TELTermPtr                    = ^TELTermRecord;

Telephone Terminals Functions

Opening and Closing Telephone Terminals

FUNCTION TELOpenTerm            (hTEL: TELHandle): TELErr;
FUNCTION TELCloseTerm           (hTEL: TELHandle): TELErr;
FUNCTION TELResetTerm           (hTEL: TELHandle): TELErr;
FUNCTION TELDispose             (hTEL: TELHandle): TELErr;

Getting Information About Telephone Terminals

FUNCTION TELGetInfo             (hTEL: TELHandle): TELErr;

Monitoring and Controlling Telephone Terminals

FUNCTION TELGetHooksw           (hTEL: TELHandle; 
                                 hookType: Integer; 
                                 VAR offHook: Boolean): TELErr;
FUNCTION TELSetHooksw           (hTEL: TELHandle; 
                                 hookType: Integer; 
                                 offHook: Boolean): TELErr;
FUNCTION TELGetVolume           (hTEL: TELHandle; 
                                 volType: Integer; 
                                 VAR level: Integer;
                                 VAR volState: Integer): TELErr;
FUNCTION TELSetVolume           (hTEL: TELHandle; 
                                 volType: Integer; 
                                 VAR level: Integer;
                                 volState: Integer): TELErr;
FUNCTION TELGetDisplay          (hTEL: TELHandle; 
                                 index: Integer; 
                                 VAR displayMode: Integer; 
                                 VAR text: StringPtr): TELErr;
FUNCTION TELSetDisplay          (hTEL: TELHandle; 
                                 index: Integer; 
                                 displayMode: Integer;
                                 text: Str255): TELErr;
FUNCTION TELAlert               (hTEL: TELHandle; 
                                 VAR level: Integer; 
                                 alertPattern: Integer): TELErr;
FUNCTION TELHSGetDTMF           (termHand: TELHandle; VAR dtmfOn: Boolean): TELErr;
FUNCTION TELHSSetDTMF           (termHand: TELHandle; dtmfOn: Boolean): TELErr;
FUNCTION TELGetIndHSConnect     (termHand: TELHandle; VAR Connect: Boolean): TELErr;
FUNCTION TELSetIndHSConnect     (termHand: TELHandle; Connect: Boolean): TELErr;

Managing Sound Input Drivers and Sound Output Components

FUNCTION TELGetHSSoundInput     (termHand: TELHandle; VAR deviceName: Str255): 
                                 TELErr;
FUNCTION TELDisposeHSSoundInput (termHand: TELHandle; deviceName: Str255): TELErr;
FUNCTION TELGetHSSoundOutput    (termHand: TELHandle; VAR SndOut: Component): TELErr;
FUNCTION TELDisposeHSSoundOutput(termHand: TELHandle; SndOut: Component): TELErr;

Allocating Processor Time to Telephone Tools

PROCEDURE TELIdle               (hTEL: TELHandle);